-
Notifications
You must be signed in to change notification settings - Fork 5.1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Release release sentinel securityinsights microsoft.security insights 2023 10 01 preview #26493
Release release sentinel securityinsights microsoft.security insights 2023 10 01 preview #26493
Conversation
…w/2023-09-01-preview to version 2023-10-01-preview
…ndable` (#25958) * Add additional OData query parameters + mark some properties as `Expandable` * Remove not needed changes * Add `x-ms-identifiers` to `dependantTemplates` array * Fix formatting issues * Add missing properties * Remove `$expand` --------- Co-authored-by: Oleh Formaniuk <oformaniuk@microsoft.com>
* Fixed Swagger correctness for SourceControls API * Fix a typo * Fix CI errors * Fixed styling --------- Co-authored-by: Oleh Formaniuk <oformaniuk@microsoft.com>
Next Steps to Merge✔️ All automated merging requirements have been met! Refer to step 4 in the PR workflow diagram (even if your PR is for data plane, not ARM). |
Swagger Validation Report
|
compared swaggers (via Oad v0.10.4)] | new version | base version |
---|---|---|
types.json | 2.0(731fecd) | 2.0(main) |
️❌
Breaking Change(Cross-Version): 3 Errors, 28 Warnings failed [Detail]
compared swaggers (via Oad v0.10.4)] | new version | base version |
---|---|---|
AlertRules.json | 2023-10-01-preview(731fecd) | 2023-02-01(main) |
AlertRules.json | 2023-10-01-preview(731fecd) | 2023-09-01-preview(main) |
AutomationRules.json | 2023-10-01-preview(731fecd) | 2023-02-01(main) |
AutomationRules.json | 2023-10-01-preview(731fecd) | 2023-09-01-preview(main) |
BillingStatistics.json | 2023-10-01-preview(731fecd) | 2023-09-01-preview(main) |
Bookmarks.json | 2023-10-01-preview(731fecd) | 2023-02-01(main) |
Bookmarks.json | 2023-10-01-preview(731fecd) | 2023-09-01-preview(main) |
ContentPackages.json | 2023-10-01-preview(731fecd) | 2023-09-01-preview(main) |
ContentProductPackages.json | 2023-10-01-preview(731fecd) | 2023-09-01-preview(main) |
ContentProductTemplates.json | 2023-10-01-preview(731fecd) | 2023-09-01-preview(main) |
ContentTemplates.json | 2023-10-01-preview(731fecd) | 2023-09-01-preview(main) |
Enrichment.json | 2023-10-01-preview(731fecd) | 2023-09-01-preview(main) |
Entities.json | 2023-10-01-preview(731fecd) | 2023-09-01-preview(main) |
EntityQueries.json | 2023-10-01-preview(731fecd) | 2023-09-01-preview(main) |
EntityQueryTemplates.json | 2023-10-01-preview(731fecd) | 2023-09-01-preview(main) |
FileImports.json | 2023-10-01-preview(731fecd) | 2023-09-01-preview(main) |
Hunts.json | 2023-10-01-preview(731fecd) | 2023-09-01-preview(main) |
Incidents.json | 2023-10-01-preview(731fecd) | 2023-02-01(main) |
Incidents.json | 2023-10-01-preview(731fecd) | 2023-09-01-preview(main) |
Metadata.json | 2023-10-01-preview(731fecd) | 2023-02-01(main) |
Metadata.json | 2023-10-01-preview(731fecd) | 2023-09-01-preview(main) |
OfficeConsents.json | 2023-10-01-preview(731fecd) | 2023-09-01-preview(main) |
OnboardingStates.json | 2023-10-01-preview(731fecd) | 2023-02-01(main) |
OnboardingStates.json | 2023-10-01-preview(731fecd) | 2023-09-01-preview(main) |
Recommendations.json | 2023-10-01-preview(731fecd) | 2023-09-01-preview(main) |
SecurityMLAnalyticsSettings.json | 2023-10-01-preview(731fecd) | 2023-02-01(main) |
SecurityMLAnalyticsSettings.json | 2023-10-01-preview(731fecd) | 2023-09-01-preview(main) |
Settings.json | 2023-10-01-preview(731fecd) | 2023-09-01-preview(main) |
SourceControls.json | 2023-10-01-preview(731fecd) | 2023-09-01-preview(main) |
ThreatIntelligence.json | 2023-10-01-preview(731fecd) | 2023-02-01(main) |
ThreatIntelligence.json | 2023-10-01-preview(731fecd) | 2023-09-01-preview(main) |
TriggeredAnalyticsRuleRuns.json | 2023-10-01-preview(731fecd) | 2023-09-01-preview(main) |
Watchlists.json | 2023-10-01-preview(731fecd) | 2023-02-01(main) |
Watchlists.json | 2023-10-01-preview(731fecd) | 2023-09-01-preview(main) |
WorkspaceManagerAssignments.json | 2023-10-01-preview(731fecd) | 2023-09-01-preview(main) |
WorkspaceManagerConfigurations.json | 2023-10-01-preview(731fecd) | 2023-09-01-preview(main) |
WorkspaceManagerGroups.json | 2023-10-01-preview(731fecd) | 2023-09-01-preview(main) |
WorkspaceManagerMembers.json | 2023-10-01-preview(731fecd) | 2023-09-01-preview(main) |
AlertTypes.json | 2023-10-01-preview(731fecd) | 2023-02-01(main) |
AlertTypes.json | 2023-10-01-preview(731fecd) | 2023-09-01-preview(main) |
ContentCommonTypes.json | 2023-10-01-preview(731fecd) | 2023-09-01-preview(main) |
EntityTypes.json | 2023-10-01-preview(731fecd) | 2023-02-01(main) |
EntityTypes.json | 2023-10-01-preview(731fecd) | 2023-09-01-preview(main) |
IncidentTypes.json | 2023-10-01-preview(731fecd) | 2023-02-01(main) |
IncidentTypes.json | 2023-10-01-preview(731fecd) | 2023-09-01-preview(main) |
RelationTypes.json | 2023-10-01-preview(731fecd) | 2023-09-01-preview(main) |
ThreatIntelligenceTypes.json | 2023-10-01-preview(731fecd) | 2023-09-01-preview(main) |
dataConnectorDefinitions.json | 2023-10-01-preview(731fecd) | 2023-09-01-preview(main) |
dataConnectors.json | 2023-10-01-preview(731fecd) | 2023-09-01-preview(main) |
operations.json | 2023-10-01-preview(731fecd) | 2023-02-01(main) |
operations.json | 2023-10-01-preview(731fecd) | 2023-09-01-preview(main) |
The following breaking changes are detected by comparison with the latest stable version:
The following breaking changes are detected by comparison with the latest preview version:
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️
LintDiff: 0 Warnings warning [Detail]
compared tags (via openapi-validator v2.1.6) | new version | base version |
---|---|---|
package-preview-2023-10 | package-preview-2023-10(731fecd) | default(main) |
The following errors/warnings exist before current PR submission:
Only 24 items are listed, please refer to log for more details.
Rule | Message |
---|---|
PutRequestResponseSchemeArm |
A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'Actions_CreateOrUpdate' Request Model: 'parameters[6].schema' Response Model: 'responses[200].schema' Location: Microsoft.SecurityInsights/preview/2023-10-01-preview/AlertRules.json#L338 |
DeleteResponseBodyEmpty |
The delete response body must be empty. Location: Microsoft.SecurityInsights/preview/2023-10-01-preview/AutomationRules.json#L148 |
DeleteResponseBodyEmpty |
The delete response body must be empty. Location: Microsoft.SecurityInsights/preview/2023-10-01-preview/AutomationRules.json#L154 |
ResourceNameRestriction |
The resource name parameter 'relationName' should be defined with a 'pattern' restriction. Location: Microsoft.SecurityInsights/preview/2023-10-01-preview/Bookmarks.json#L331 |
XmsIdentifierValidation |
Missing identifier id in array item property Location: Microsoft.SecurityInsights/preview/2023-10-01-preview/Bookmarks.json#L566 |
ArrayMustHaveType |
'items.type' property must be truthy Location: Microsoft.SecurityInsights/preview/2023-10-01-preview/dataConnectors.json#L2393 |
ArrayMustHaveType |
'items.type' property must be truthy Location: Microsoft.SecurityInsights/preview/2023-10-01-preview/dataConnectors.json#L2405 |
ArrayMustHaveType |
'items.type' property must be truthy Location: Microsoft.SecurityInsights/preview/2023-10-01-preview/dataConnectors.json#L2417 |
ArrayMustHaveType |
'items.type' property must be truthy Location: Microsoft.SecurityInsights/preview/2023-10-01-preview/dataConnectors.json#L2429 |
ArrayMustHaveType |
'items.type' property must be truthy Location: Microsoft.SecurityInsights/preview/2023-10-01-preview/dataConnectors.json#L2449 |
ArrayMustHaveType |
'items.type' property must be truthy Location: Microsoft.SecurityInsights/preview/2023-10-01-preview/dataConnectors.json#L2825 |
ArrayMustHaveType |
'items.type' property must be truthy Location: Microsoft.SecurityInsights/preview/2023-10-01-preview/dataConnectors.json#L2837 |
ArrayMustHaveType |
'items.type' property must be truthy Location: Microsoft.SecurityInsights/preview/2023-10-01-preview/dataConnectors.json#L2933 |
GetCollectionOnlyHasValueAndNextLink |
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: Microsoft.SecurityInsights/preview/2023-10-01-preview/Entities.json#L315 |
ResourceNameRestriction |
The resource name parameter 'relationName' should be defined with a 'pattern' restriction. Location: Microsoft.SecurityInsights/preview/2023-10-01-preview/Entities.json#L437 |
DefinitionsPropertiesNamesCamelCase |
Property name should be camel case. Location: Microsoft.SecurityInsights/preview/2023-10-01-preview/Entities.json#L1204 |
PutRequestResponseSchemeArm |
A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'EntityQueries_CreateOrUpdate' Request Model: 'parameters[5].schema' Response Model: 'responses[200].schema' Location: Microsoft.SecurityInsights/preview/2023-10-01-preview/EntityQueries.json#L132 |
XmsEnumValidation |
The enum types should have x-ms-enum type extension set with appropriate options. Location: Microsoft.SecurityInsights/preview/2023-10-01-preview/EntityQueries.json#L484 |
XmsIdentifierValidation |
Missing identifier id in array item property Location: Microsoft.SecurityInsights/preview/2023-10-01-preview/EntityQueryTemplates.json#L234 |
XmsEnumValidation |
The enum types should have x-ms-enum type extension set with appropriate options. Location: Microsoft.SecurityInsights/preview/2023-10-01-preview/EntityQueryTemplates.json#L292 |
PutResponseCodes |
Synchronous and long-running PUT operations must have responses with 200, 201 and default return codes. They also must not have other response codes. Location: Microsoft.SecurityInsights/preview/2023-10-01-preview/FileImports.json#L138 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.SecurityInsights/preview/2023-10-01-preview/FileImports.json#L213 |
LroErrorContent |
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.SecurityInsights/preview/2023-10-01-preview/FileImports.json#L225 |
ResourceNameRestriction |
The resource name parameter 'relationName' should be defined with a 'pattern' restriction. Location: Microsoft.SecurityInsights/preview/2023-10-01-preview/Incidents.json#L698 |
️️✔️
Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️
SwaggerAPIView succeeded [Detail] [Expand]
️️✔️
TypeSpecAPIView succeeded [Detail] [Expand]
️️✔️
ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️
SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️
PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️
PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️
SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️
Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️
PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️
Automated merging requirements met succeeded [Detail] [Expand]
Swagger Generation Artifacts
|
Generated ApiView
|
Please address or respond to feedback from the ARM API reviewer. |
Hi @xuhumsft! For review efficiency consideration, when creating a new API version, it is required to place API specs of the base version in the first commit, and push new version updates into successive commits. You can use OpenAPIHub to initialize the PR for adding a new version. |
/azp run |
Azure Pipelines successfully started running 3 pipeline(s). |
...s/resource-manager/Microsoft.SecurityInsights/preview/2023-10-01-preview/SourceControls.json
Outdated
Show resolved
Hide resolved
...s/resource-manager/Microsoft.SecurityInsights/preview/2023-10-01-preview/SourceControls.json
Outdated
Show resolved
Hide resolved
The PR to fix the spellcheck |
Swagger pipeline restarted successfully, please wait for status update in this comment. |
… 2023 10 01 preview (#26493) * Add additional OData query parameters * Add `x-ms-identifiers` to `dependantTemplates` array
ARM (Control Plane) API Specification Update Pull Request
PR review workflow diagram
Please understand this diagram before proceeding. It explains how to get your PR approved & merged.
[1] ARM review queue (for merge queues, see [4])
The PRs are processed by time opened, ascending. Your PR may show up on 2nd or later page.
If you addressed Step 1 from the diagram and your PR is not showing up in the queue, ensure the label
ARMChangesRequested
is removed from your PR. This should cause the label
WaitForARMFeedback
to be added.[2] https://aka.ms/azsdk/support/specreview-channel
[3] List of SDK breaking changes approvers in pinned Teams announcement
[4] public repo merge queue, private repo merge queue (for ARM review queue, [1])
If you need further help with anything, see
Getting help
section below.Purpose of this PR
What's the purpose of this PR? Check all that apply. This is mandatory!
Due diligence checklist
To merge this PR, you must go through the following checklist and confirm you understood
and followed the instructions by checking all the boxes:
ARM resource provider contract and
REST guidelines (estimated time: 4 hours).
I understand this is required before I can proceed to Step 2, "ARM Review", for this PR.
Breaking changes review (Step 1)
you must follow the breaking changes process.
IMPORTANT This applies even if:
Such claims must be reviewed, and the process is the same.
ARM API changes review (Step 2)
ARMReview
label.Viewing API changes
For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the
Generated ApiView
comment added to this PR. You can use ApiView to show API versions diff.Suppressing failures
If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the
Swagger-Suppression-Process
to get approval.
Getting help
and https://aka.ms/ci-fix.